home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / PROGRAMM / PASCAL / 0407.ZIP / SPELL12.ARC / SPELL.DOC < prev    next >
Text File  |  1986-07-28  |  11KB  |  216 lines
  1.  
  2. SpellCheck Public Domain Spelling Checker           (c) 1986 by Frank LaRosa
  3.  
  4. -----------------------------------------------------------------------------
  5.  
  6. SHAREWARE NOTICE: This program is distributed via the Shareware system. If
  7. you find this program useful, please register your copy by sending in the
  8. shareware registration fee as outlined below. Even if you don't register,
  9. please share this program with others.
  10.  
  11. -----------------------------------------------------------------------------
  12.  
  13. SpellCheck is a spelling checker for the IBM-PC and compatables.
  14. The major features of this program are as follows:
  15.  
  16. * Checks text or document files from most word processors, as well as 
  17.   standard ASCII text files.
  18. * Shows misspellings on screen, in context, with option to add to dictionary.
  19. * Maintains main plus alternate dictionaries.
  20. * Optionally prints error report on printer or file.
  21. * Allows manual update of dictionaries (add & delete words).
  22. * Menu driven operation
  23.  
  24. Installation Instructions
  25. The SpellCheck package consists of the following files:
  26.  
  27. SPELL.EXE     The SpellCheck program
  28. SPELL.CTL     A small "control" file
  29. MAIN.DCT      The main dictionary file
  30. SPELL.DOC     This documentation file
  31.  
  32. You will need all four of these files in order to use the system. If any files 
  33. are missing, you can obtain the entire package by following the directions 
  34. under "Shareware Registration".
  35.  
  36. Floppy Disk Installation
  37. Format a clean disk (double sided, 360K capacity) to receive the system. Next, 
  38. copy the files SPELL.EXE, SPELL.CTL and MAIN.DCT onto the new disk. Label this 
  39. disk as your working copy, and DO NOT copy any other files onto it. The Spell-
  40. Check dictionary file is designed to expand to a size of approx. 310K, and 
  41. thus will require nearly all of the space on a 360K disk. Because of the 
  42. hashcode algorthms used to store words, the dictionary will expand quickly to 
  43. its full size; however, this does not mean the dictionary is "full" and cannot 
  44. accept new words. The actual capacity of each dictionary file will be in the 
  45. range of 30-40,000 words.  
  46.  
  47. Hard Disk Installation
  48. The current version of SpellCheck does not support DOS 2+ subdirectories. If 
  49. you have a hard disk, you will have to install SpellCheck in one of the 
  50. following ways: 1. Install all the files in the root directory of drive C:, or 
  51. 2. Install all the files in a directory called "SPELL". If you use the second 
  52. method, you must move to the SPELL directory before executing the program. 
  53. Type "cd c:\spell" or better yet, create a batch file. In either case, the 
  54. file being checked must also be present in the same directory as SPELL.EXE and 
  55. the dictionary and control files. I am sorry for this limitation.  Provisions 
  56. have been made in the program to support extended pathnames, I am merely 
  57. awaiting a newer version of my compiler that will support the DOS subdirectory 
  58. structure.  
  59.  
  60. RAM Disk Usage
  61. If a ramdisk of 360K capacity is available on your system, I suggest copying 
  62. the dictionary file (MAIN.DCT) into the ram disk. This will greatly speed up 
  63. the program since most of the processing time is spent reading the dictionary.  
  64. If you install MAIN.DCT on the "root" directory of your ramdisk, you need not 
  65. copy any of the other files onto the ramdisk; instead, use the "Set Pathnames" 
  66. option of SpellCheck to tell the program where the dictionary is (see below 
  67. for further information).  
  68.  
  69. Running The Program
  70. To run the program, enter the command SPELL. Remember that SPELL.CTL and 
  71. MAIN.DCT must initially reside in the same directory, which must be the 
  72. "current" directory when SPELL is executed. If desired, you can relocate the 
  73. dictionary or the SPELL program itself by using the "Set Pathnames" option, or 
  74. by creating a batch file to control execution.  
  75.  
  76. Menus and Editing
  77. All operations are controlled by menus. To select an option from a menu, just 
  78. press the key corresponding to the option. Or, highlight the option (press the 
  79. spacebar, backspace, or arrow keys to move the inverse bar) and press Return.  
  80. When typing in a word or a filename, the standard IBM editing keys are 
  81. enabled.  You can press the left arrow, right arrow, ins and del keys to edit 
  82. your input.  
  83.  
  84. Setting Pathnames
  85. When SpellCheck boots up, it looks for a file named "SPELL.CTL" and reads 
  86. three lines from this file. The three strings read are the name of the main 
  87. dictionary file, the name of the alternate dictionary (if used), and the name 
  88. of the lineprinter device or filespec. If you rename the main dictionary or 
  89. reside it on a different disk drive, or create alternate dictionaries, use the 
  90. "Set Pathnames" option to change this control information. At the SpellCheck 
  91. main menu, type "S". You will then be prompted for the three pieces of 
  92. information. For example, if you have a ramdisk set up as drive D:, you could 
  93. copy MAIN.DCT to drive D: and enter the main dictionary filespec as 
  94. D:MAIN.DCT.  This will allow the program to look on drive D: for MAIN.DCT each 
  95. time you run it. You can also specify an alternate dictionary, and a printer 
  96. device spec (used to print an error report; use PRN to print on the printer, 
  97. or type another device or filename to divert the output to another location).  
  98.  
  99. Creating Alternate Dictionaries
  100. To create a new, blank dictionary file, go to the "Dictionary Operations" menu 
  101. and select option C, "Create New Dictionary". Type the name of the new file, 
  102. and it will be created. To actually use the alternate dictionary, however, you 
  103. must set the pathname to it as described above.  Alternate dictionaries are 
  104. used in conjunction with the main dictionary when proofreading files. You can 
  105. use the alternate dictionary to store words which appear frequently in your 
  106. documents but are not english words, such as proper names, slang, and 
  107. technical terms. You may wish to create a temporary alt dictionary, perhaps on 
  108. ramdisk, just for use while checking one particular file or group of files.  
  109.  
  110. Maintaining Dictionaries
  111. Main menu options D and A allow you to maintain the "main" and "alternate" 
  112. dictionary files. The dictionary operations menus give you options to search, 
  113. add, and delete individual words from the dictionaries. In addition, the "Add 
  114. Words From File" option will read in an entire text file and add all words 
  115. found in the file to the dictionary (if they were not already there). You can 
  116. use this option to initialize an empty dictionary using a text or document 
  117. file that you know contains no errors. When reading the file, all control or 
  118. special characters, numerals, and punctuation (except for the apostrophe) are 
  119. ignored.  Lowercase is converted to uppercase before adding words to the 
  120. dictionary and before searching for words in the dictionary.  
  121.  
  122. Proofreading
  123. The heart of the program is the Proofread command. Type P and enter the name 
  124. of the file to be read. If you type the filename incorrectly or the file does 
  125. not exits, a message to this effect is shown on the screen, and you can re-
  126. enter the filename. You can also press ESC to abort the function.  
  127.  
  128. Proofreading options are:
  129. Use Alternate Dictionary - If the alternate dictionary is available and you 
  130. answer "Y" to this option, it will be used in conjunction with the main 
  131. dictionary when searching for words. Pressing "N" will cause only the main 
  132. dictionary to be used.  
  133.  
  134. Print Error Report - If "Y" is selected, a report of unknown words is printed 
  135. to the printer (or to whatever filename is specified as the printer device).  
  136.  
  137. Pause at Each Error - If selected, the program will stop at each error found 
  138. and display the unknown word, line number, the word in context, and a menu of 
  139. options. In response, you type one of the following: 
  140.  
  141. A - Add word to dictionary. The word is added to the main dictionary.
  142. T - Add the word to the alternate dictionary. If the alt dictionary is active 
  143.     (initialized), this option can be used regardless of whether the alt
  144.     dictionary is being used to proofread the file.
  145. C - Continue. Confirm the misspelling and continue on.
  146. I - Ignore the error. Specifically, if an error report is being generated, do 
  147.     not show this word on the report. (But the counter on the screen will 
  148.     still reflect the error).  
  149. Q - Quit. Abort the operation at this point. You can also abort while the 
  150.     program is actively checking words by pressing the ESC key.  
  151.  
  152. The total number of words checked, errors found, and words added to the 
  153. dictionaries is displayed on the screen during proofreading. When completed, 
  154. use the error report (if generated) to correct the misspellings.  
  155.  
  156. Exiting
  157. Always exit the program by pressing "X" on the main menu. If you exit 
  158. improperly (such as by re-booting) the proper EOF markers will not be written 
  159. to the files, and you will have problems later on.  
  160.  
  161. If you have any additional questions, or would like to suggest improvements or 
  162. report bugs, please contact me (address and phone number given below).  
  163.  
  164.  
  165.  
  166. -------------------------------------------------------------------------------
  167.  
  168.                           Shareware Registration
  169.  
  170. This program is distributed on the "Shareware" system. You may freely copy and 
  171. distribute this program, but if you use it PLEASE register. Registration costs 
  172. only $22, and entitles you to use all future versions of SpellCheck. Help 
  173. fight the high cost of software by supporting your independent shareware 
  174. programmer! Send checks to: 
  175.  
  176.            Frank LaRosa
  177.            46 Twixt Hills Rd.
  178.            St. James, NY 11780
  179.  
  180. If you would like to receive the latest copy of SpellCheck on disk, including 
  181. all documentation, dictionaries, etc., include your name and address and an 
  182. extra $3 to cover the costs of diskettes and mailing ($25 total). The source 
  183. code is also available; just request it when ordering a disk.  
  184.  
  185. You can download copies of SpellCheck (distributed as SPELLXX.ARC, where XX is 
  186. the version number) from various bulletin boards around the country. To get 
  187. the newest versions or to contact me with comments or suggestions, call my 
  188. bbs, The Searchlight, at (516) 724-0971. It's up 24 hours at 300/1200 baud.  
  189.  
  190. ** Look for my other Public Domain releases! **
  191.  
  192.    OTH-PC.EXE    Super Sonic OTHELLO Game
  193.    RPN.ARC       Programmable RPN Scientific Calculator
  194.  
  195. Available on fine Bulletin Board Systems everywhere!
  196.  
  197. -------------------------------------------------------------------------------
  198.  
  199. 
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.